<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>[Generic Component Framework v3] GCF::QmlComponent Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<!--link href="tabs.css" rel="stylesheet" type="text/css"-->
</head><body>
 <div id="wrapper">
    <div id="logo_box">
        <a class="img_link" href="https://github.com/pnudupa/gcf" target="_blank" ><img style="float:left;margin-left:10px;margin-top:5px;margin-bottom:5px;"src="header_gcf_logo.jpg" alt="GCF LOGO"/></a>
        <a class="img_link" href="https://www.vcreatelogic.com/" target="_blank" ><img style="float:right;margin-right:10px; margin-top: 30px;" src="header_vcl_logo.jpg" alt="VCL LOGO"/></a>
        <div style="clear:both"></div>
    </div>
    <div class="nav">
        <ul>
            <li class="selectedpage">
                <a class="a-home" href="index.html" >
                    <span>Home</span>
                </a>
            </li>
            <li>
                <a class="a-classes " href="classes.html">
                    <span>All Classes</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_modules.html">
                    <span>Modules</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_guides_and_videos.html">
                    <span>Guides & Videos</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_tools_and_inbuilt_components.html">
                    <span>Tools & Components</span>
                </a>
            </li>
        </ul>
    </div>
    <div id="main-content">
        <div class="inside">
        <div>
<!-- Generated by Doxygen 1.8.16 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>GCF</b></li><li class="navelem"><a class="el" href="class_g_c_f_1_1_qml_component.html">QmlComponent</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_g_c_f_1_1_qml_component-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">GCF::QmlComponent Class Reference<div class="ingroups"><a class="el" href="group__gcf__quick.html">GCF Quick Module</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Extends <a class="el" href="class_g_c_f_1_1_component.html">GCF::Component</a> to ease creation of QML components.  
 <a href="class_g_c_f_1_1_qml_component.html#details">More...</a></p>

<p><code>#include &lt;GCF3/QmlComponent&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae3297ce7f63c134d9d271d40fe396638"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#ae3297ce7f63c134d9d271d40fe396638">QmlComponent</a> (QObject *parent=nullptr)</td></tr>
<tr class="separator:ae3297ce7f63c134d9d271d40fe396638"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a949b57c9db4bbb8f7b5c44217a51d245"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a949b57c9db4bbb8f7b5c44217a51d245">isActive</a> () const</td></tr>
<tr class="separator:a949b57c9db4bbb8f7b5c44217a51d245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7db65fd422fc5dfaae093b507cd8f1b4"><td class="memItemLeft" align="right" valign="top">Q_SIGNAL void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a7db65fd422fc5dfaae093b507cd8f1b4">activeChanged</a> (bool val)</td></tr>
<tr class="separator:a7db65fd422fc5dfaae093b507cd8f1b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21f5a5a2e0e667083edd5f5e41ea1a3e"><td class="memItemLeft" align="right" valign="top">QObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a21f5a5a2e0e667083edd5f5e41ea1a3e">addQml</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>, const QUrl &amp;url)</td></tr>
<tr class="separator:a21f5a5a2e0e667083edd5f5e41ea1a3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb31266005d6b24de63694fac0ad7ed9"><td class="memItemLeft" align="right" valign="top">QObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#adb31266005d6b24de63694fac0ad7ed9">addQml</a> (const QUrl &amp;url)</td></tr>
<tr class="separator:adb31266005d6b24de63694fac0ad7ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac07b2cf80ebe0f0137042a7fbcd93d90"><td class="memItemLeft" align="right" valign="top">Q_INVOKABLE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#ac07b2cf80ebe0f0137042a7fbcd93d90">addQmlItem</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>, QObject *object)</td></tr>
<tr class="separator:ac07b2cf80ebe0f0137042a7fbcd93d90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a263ef1d66ac02c893161b9103fabd2a5"><td class="memItemLeft" align="right" valign="top">Q_INVOKABLE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a263ef1d66ac02c893161b9103fabd2a5">removeQmlItem</a> (QObject *object)</td></tr>
<tr class="separator:a263ef1d66ac02c893161b9103fabd2a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33008b1697ff642a3e0a930185a6c63f"><td class="memItemLeft" align="right" valign="top">Q_INVOKABLE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a33008b1697ff642a3e0a930185a6c63f">removeQmlItem</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>)</td></tr>
<tr class="separator:a33008b1697ff642a3e0a930185a6c63f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e047dab3f159d529a265ab10fdce4ff"><td class="memItemLeft" align="right" valign="top">Q_INVOKABLE QObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a2e047dab3f159d529a265ab10fdce4ff">qmlItem</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>) const</td></tr>
<tr class="separator:a2e047dab3f159d529a265ab10fdce4ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_g_c_f_1_1_component"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_g_c_f_1_1_component')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_g_c_f_1_1_component.html">GCF::Component</a></td></tr>
<tr class="memitem:a0a8e6280e3029cab1db39d4a0b0cdf11 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a0a8e6280e3029cab1db39d4a0b0cdf11">Component</a> (QObject *parent=nullptr)</td></tr>
<tr class="separator:a0a8e6280e3029cab1db39d4a0b0cdf11 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a424f54d7c57c719b0ec16c3094ca565a inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a> () const</td></tr>
<tr class="separator:a424f54d7c57c719b0ec16c3094ca565a inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1902eb93c5fce2f2aa82e39b5fd2c494 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a1902eb93c5fce2f2aa82e39b5fd2c494">organization</a> () const</td></tr>
<tr class="separator:a1902eb93c5fce2f2aa82e39b5fd2c494 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac21a96f4b23f6ac1ce997c86726dba2e inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_g_c_f_1_1_version.html">GCF::Version</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#ac21a96f4b23f6ac1ce997c86726dba2e">version</a> () const</td></tr>
<tr class="separator:ac21a96f4b23f6ac1ce997c86726dba2e inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac61518ed80c6a172b25cac4a6666f882 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#ac61518ed80c6a172b25cac4a6666f882">buildTimestamp</a> () const</td></tr>
<tr class="separator:ac61518ed80c6a172b25cac4a6666f882 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8105c199273cebd258ffda96e191c3d9 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">const QSettings *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a8105c199273cebd258ffda96e191c3d9">settings</a> () const</td></tr>
<tr class="separator:a8105c199273cebd258ffda96e191c3d9 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a051e5aca7176bec532dcf28e43012708 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a051e5aca7176bec532dcf28e43012708">isLoaded</a> () const</td></tr>
<tr class="separator:a051e5aca7176bec532dcf28e43012708 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e35213d5a5c8933a78a3fb10e737459 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a9e35213d5a5c8933a78a3fb10e737459">isActive</a> () const</td></tr>
<tr class="separator:a9e35213d5a5c8933a78a3fb10e737459 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06e3573f06292a5211b81201ced61deb inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a06e3573f06292a5211b81201ced61deb">load</a> ()</td></tr>
<tr class="separator:a06e3573f06292a5211b81201ced61deb inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c7530baab5694de7676a76eeb50eb3f inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a8c7530baab5694de7676a76eeb50eb3f">unload</a> ()</td></tr>
<tr class="separator:a8c7530baab5694de7676a76eeb50eb3f inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a6e0f95047a60edfb6e25c374a74340 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a7a6e0f95047a60edfb6e25c374a74340">activate</a> ()</td></tr>
<tr class="separator:a7a6e0f95047a60edfb6e25c374a74340 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19620ff366fc68e58ddf532acb54a598 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a19620ff366fc68e58ddf532acb54a598">deactivate</a> ()</td></tr>
<tr class="separator:a19620ff366fc68e58ddf532acb54a598 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8791368cb9615392e6c9c2d380034f1 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#ac8791368cb9615392e6c9c2d380034f1">addContentObject</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>, QObject *object, const QVariantMap &amp;info=QVariantMap())</td></tr>
<tr class="separator:ac8791368cb9615392e6c9c2d380034f1 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5419a2ae3965f0994c50f68f48cb9ea5 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a5419a2ae3965f0994c50f68f48cb9ea5">addContentObject</a> (QObject *object, const QVariantMap &amp;info=QVariantMap())</td></tr>
<tr class="separator:a5419a2ae3965f0994c50f68f48cb9ea5 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b0b7fe34462a0ba01ab38f348c024d6 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a5b0b7fe34462a0ba01ab38f348c024d6">removeContentObject</a> (QObject *object)</td></tr>
<tr class="separator:a5b0b7fe34462a0ba01ab38f348c024d6 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f1eee986efea04923574a43901a19f2 inherit pub_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a5f1eee986efea04923574a43901a19f2">removeContentObject</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>)</td></tr>
<tr class="separator:a5f1eee986efea04923574a43901a19f2 inherit pub_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a197ae580ded5c30ef7a91442ecc51bf1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a197ae580ded5c30ef7a91442ecc51bf1">~QmlComponent</a> ()</td></tr>
<tr class="separator:a197ae580ded5c30ef7a91442ecc51bf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc878e70ab78b826a58d488c85a7adf7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#acc878e70ab78b826a58d488c85a7adf7">initializeEvent</a> (<a class="el" href="class_g_c_f_1_1_initialize_event.html">GCF::InitializeEvent</a> *e)</td></tr>
<tr class="separator:acc878e70ab78b826a58d488c85a7adf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d20f66abca3b375227adbf099444266"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a8d20f66abca3b375227adbf099444266">activationEvent</a> (<a class="el" href="class_g_c_f_1_1_activation_event.html">GCF::ActivationEvent</a> *e)</td></tr>
<tr class="separator:a8d20f66abca3b375227adbf099444266"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae94060a64aed580940b7e396d137e3bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#ae94060a64aed580940b7e396d137e3bd">deactivationEvent</a> (<a class="el" href="class_g_c_f_1_1_deactivation_event.html">GCF::DeactivationEvent</a> *e)</td></tr>
<tr class="separator:ae94060a64aed580940b7e396d137e3bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4369fecfd2a15454b5910aedb26f468e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a4369fecfd2a15454b5910aedb26f468e">contentObjectLoadEvent</a> (<a class="el" href="class_g_c_f_1_1_content_object_load_event.html">GCF::ContentObjectLoadEvent</a> *e)</td></tr>
<tr class="separator:a4369fecfd2a15454b5910aedb26f468e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c927dfcac5f5388bb78efb94c1e420a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a9c927dfcac5f5388bb78efb94c1e420a">contentObjectMergeEvent</a> (<a class="el" href="class_g_c_f_1_1_content_object_merge_event.html">GCF::ContentObjectMergeEvent</a> *e)</td></tr>
<tr class="separator:a9c927dfcac5f5388bb78efb94c1e420a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae34b5127bb153d20ab27e9cc8c514325"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#ae34b5127bb153d20ab27e9cc8c514325">contentObjectUnloadEvent</a> (<a class="el" href="class_g_c_f_1_1_content_object_unload_event.html">GCF::ContentObjectUnloadEvent</a> *e)</td></tr>
<tr class="separator:ae34b5127bb153d20ab27e9cc8c514325"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab746732385fc42c931e6802863d19d3c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#ab746732385fc42c931e6802863d19d3c">contentObjectUnmergeEvent</a> (<a class="el" href="class_g_c_f_1_1_content_object_unmerge_event.html">GCF::ContentObjectUnmergeEvent</a> *e)</td></tr>
<tr class="separator:ab746732385fc42c931e6802863d19d3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77275d9f06e56f415129e6f3c1a09784"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a77275d9f06e56f415129e6f3c1a09784">activateContentObjectEvent</a> (<a class="el" href="class_g_c_f_1_1_activate_content_object_event.html">GCF::ActivateContentObjectEvent</a> *e)</td></tr>
<tr class="separator:a77275d9f06e56f415129e6f3c1a09784"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22a59c8b43d2583ae3756d0bf3169b12"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a22a59c8b43d2583ae3756d0bf3169b12">deactivateContentObjectEvent</a> (<a class="el" href="class_g_c_f_1_1_deactivate_content_object_event.html">GCF::DeactivateContentObjectEvent</a> *e)</td></tr>
<tr class="separator:a22a59c8b43d2583ae3756d0bf3169b12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeed9744234d057c47cd85526551af630"><td class="memItemLeft" align="right" valign="top">virtual QObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#aeed9744234d057c47cd85526551af630">loadQmlObject</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>, const QUrl &amp;url, const QVariantMap &amp;info)</td></tr>
<tr class="separator:aeed9744234d057c47cd85526551af630"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6df1b1a303bf1751c81db608c7647b14"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_qml_component.html#a6df1b1a303bf1751c81db608c7647b14">unloadQmlObject</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>, QObject *qmlObject, const QVariantMap &amp;info)</td></tr>
<tr class="separator:a6df1b1a303bf1751c81db608c7647b14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_class_g_c_f_1_1_component"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_g_c_f_1_1_component')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_g_c_f_1_1_component.html">GCF::Component</a></td></tr>
<tr class="memitem:a0da80fa064fa71d0e048ed9c45f54eec inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a0da80fa064fa71d0e048ed9c45f54eec">~Component</a> ()</td></tr>
<tr class="separator:a0da80fa064fa71d0e048ed9c45f54eec inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06a056e6114fbaa341874a2064c6562b inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a06a056e6114fbaa341874a2064c6562b">finalizeEvent</a> (<a class="el" href="class_g_c_f_1_1_finalize_event.html">GCF::FinalizeEvent</a> *e)</td></tr>
<tr class="separator:a06a056e6114fbaa341874a2064c6562b inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b9e7071c2f4b483a4ee51b08b70835c inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a7b9e7071c2f4b483a4ee51b08b70835c">contentLoadEvent</a> (<a class="el" href="class_g_c_f_1_1_content_load_event.html">GCF::ContentLoadEvent</a> *e)</td></tr>
<tr class="separator:a7b9e7071c2f4b483a4ee51b08b70835c inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c46c693324b5e524e5c1188dfb4560d inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a4c46c693324b5e524e5c1188dfb4560d">settingsLoadEvent</a> (<a class="el" href="class_g_c_f_1_1_settings_load_event.html">GCF::SettingsLoadEvent</a> *e)</td></tr>
<tr class="separator:a4c46c693324b5e524e5c1188dfb4560d inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47f8742e87fa5ad86ed822cb60d90a79 inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a47f8742e87fa5ad86ed822cb60d90a79">contentUnloadEvent</a> (<a class="el" href="class_g_c_f_1_1_content_unload_event.html">GCF::ContentUnloadEvent</a> *e)</td></tr>
<tr class="separator:a47f8742e87fa5ad86ed822cb60d90a79 inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03b90d525333d9a4e5f34fd16ad8bf35 inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a03b90d525333d9a4e5f34fd16ad8bf35">settingsUnloadEvent</a> (<a class="el" href="class_g_c_f_1_1_settings_unload_event.html">GCF::SettingsUnloadEvent</a> *e)</td></tr>
<tr class="separator:a03b90d525333d9a4e5f34fd16ad8bf35 inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa764b26829ba318385b3921bf2b1800a inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual QObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#aa764b26829ba318385b3921bf2b1800a">loadObject</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>, const QVariantMap &amp;info)</td></tr>
<tr class="separator:aa764b26829ba318385b3921bf2b1800a inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad403e437d09e17139abe5bab8ae3f1e6 inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#ad403e437d09e17139abe5bab8ae3f1e6">unloadObject</a> (const QString &amp;<a class="el" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>, QObject *object, const QVariantMap &amp;info)</td></tr>
<tr class="separator:ad403e437d09e17139abe5bab8ae3f1e6 inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92c9170c1333e88d516ec3eca693bfda inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a92c9170c1333e88d516ec3eca693bfda">mergeObject</a> (QObject *parent, QObject *child, const QVariantMap &amp;parentInfo, const QVariantMap &amp;childInfo)</td></tr>
<tr class="separator:a92c9170c1333e88d516ec3eca693bfda inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c371df2820b3c36a814005a4a9910df inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a8c371df2820b3c36a814005a4a9910df">unmergeObject</a> (QObject *parent, QObject *child, const QVariantMap &amp;parentInfo, const QVariantMap &amp;childInfo)</td></tr>
<tr class="separator:a8c371df2820b3c36a814005a4a9910df inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa98b557a1c9a04a5f8f4586394174316 inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#aa98b557a1c9a04a5f8f4586394174316">activateObject</a> (QObject *parent, QObject *child, const QVariantMap &amp;parentInfo, const QVariantMap &amp;childInfo)</td></tr>
<tr class="separator:aa98b557a1c9a04a5f8f4586394174316 inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4018ebb487bbe088b34e662a38c61fc8 inherit pro_methods_class_g_c_f_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_component.html#a4018ebb487bbe088b34e662a38c61fc8">deactivateObject</a> (QObject *parent, QObject *child, const QVariantMap &amp;parentInfo, const QVariantMap &amp;childInfo)</td></tr>
<tr class="separator:a4018ebb487bbe088b34e662a38c61fc8 inherit pro_methods_class_g_c_f_1_1_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class offers QML friendly methods to make creation of QML components in GCF applications really simple. Please note that there is a difference in the meaning of the term <b>QML-Component</b> when used in Qt 5 context and when used in GCF context. Unless otherwise stated the term <b>QML-Component</b> in this class document refers to an instance of <a class="el" href="class_g_c_f_1_1_qml_component.html">GCF::QmlComponent</a> class.</p>
<p>This class reimplements </p><ul>
<li><a class="el" href="class_g_c_f_1_1_component.html#a75422842587613d43844e73fb8ca021d">GCF::Component::initializeEvent()</a> - to check whether the component is being loaded in a GCF QML application or not. The component asserts a failure and crashes the application otherwise.</li>
</ul>
<ul>
<li><a class="el" href="class_g_c_f_1_1_component.html#a464361482ef9039aee875940ae64306c">GCF::Component::activationEvent()</a> and <a class="el" href="class_g_c_f_1_1_component.html#afb0e763839f42c3cca61d22c3ee7e1ce">GCF::Component::deactivationEvent()</a> - to gather changes to component activation and update the active property.</li>
</ul>
<ul>
<li><a class="el" href="class_g_c_f_1_1_component.html#a8447de04766d75220159e9db2ceeb5c8">GCF::Component::contentObjectLoadEvent()</a> - to identify qml object kinds and support loading / instantiation of QML objects from <code></code>.qml files.</li>
</ul>
<ul>
<li><a class="el" href="class_g_c_f_1_1_component.html#a1de83ead9a736b7fe19f61626b24a5b6">GCF::Component::contentObjectMergeEvent()</a> - to ignore merge events for QML objects</li>
</ul>
<ul>
<li><a class="el" href="class_g_c_f_1_1_component.html#a692d57781b5f4e9034624e31b6727c14">GCF::Component::contentObjectUnloadEvent()</a> - to unload QML objects effectively</li>
</ul>
<ul>
<li><a class="el" href="class_g_c_f_1_1_component.html#a2ddd32175fb6ca0dec4ca0b7443543ce">GCF::Component::contentObjectUnmergeEvent()</a> - to ignore unmerge events for QML objects</li>
</ul>
<ul>
<li><a class="el" href="class_g_c_f_1_1_component.html#acdc6848ac70f5c13c78b6782a5666cd3">GCF::Component::activateContentObjectEvent()</a> - to ignore activation events for QML objects</li>
</ul>
<ul>
<li><a class="el" href="class_g_c_f_1_1_component.html#a8fe3cdb6bb891d7e67d498a3a55900b3">GCF::Component::deactivateContentObjectEvent()</a> - to ignore deactivation events for QML objects</li>
</ul>
<p>Content files for QML components can make use of <code>type=qml</code> and <code>url=</code> attributes in <code>object</code> XML element to load QML objects. Example</p>
<div class="fragment"><div class="line">&lt;content&gt;</div>
<div class="line">    &lt;<span class="keywordtype">object</span> <a class="code" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>=<span class="stringliteral">&quot;root&quot;</span> type=<span class="stringliteral">&quot;qml&quot;</span> <a class="code" href="group__gcf__core.html#ga051df405b83d549ef2b40870bd77df3c">url</a>=<span class="stringliteral">&quot;qrc:///RootItem.qml&quot;</span> &gt;</div>
<div class="line">    &lt;<span class="keywordtype">object</span> <a class="code" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>=<span class="stringliteral">&quot;sample&quot;</span> type=<span class="stringliteral">&quot;qml&quot;</span> <a class="code" href="group__gcf__core.html#ga051df405b83d549ef2b40870bd77df3c">url</a>=<span class="stringliteral">&quot;http://www.something.com/Sample.qml&quot;</span> &gt;</div>
<div class="line">    &lt;<span class="keywordtype">object</span> <a class="code" href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">name</a>=<span class="stringliteral">&quot;another&quot;</span> type=<span class="stringliteral">&quot;qml&quot;</span> <a class="code" href="group__gcf__core.html#ga051df405b83d549ef2b40870bd77df3c">url</a>=<span class="stringliteral">&quot;file:///Users/jaggesh/Another.qml&quot;</span> &gt;</div>
<div class="line">&lt;/content&gt;</div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>QML files loaded using this class, either through content-files or by calling the <a class="el" href="class_g_c_f_1_1_qml_component.html#a21f5a5a2e0e667083edd5f5e41ea1a3e">addQml()</a> function, can make use of a <code>gComponent</code> object in their code to reference <code>this</code> component.</dd></dl>
<p>This class also offers a specialized virtual function called <a class="el" href="class_g_c_f_1_1_qml_component.html#aeed9744234d057c47cd85526551af630">loadQmlObject()</a>, whose default implementation eases out loading of QML objects from <code></code>.qml files. Subclasses can reimplement this function to customize the loading of QML objects.</p>
<p>The <a class="el" href="class_g_c_f_1_1_qml_component.html#a21f5a5a2e0e667083edd5f5e41ea1a3e">addQml()</a> methods may be used to add QML objects from <code></code>.qml files - without loading them from the content-file. Custom QML items can be added using <a class="el" href="class_g_c_f_1_1_qml_component.html#ac07b2cf80ebe0f0137042a7fbcd93d90">addQmlItem()</a> method. QML items added using <a class="el" href="class_g_c_f_1_1_qml_component.html#a21f5a5a2e0e667083edd5f5e41ea1a3e">addQml()</a> or <a class="el" href="class_g_c_f_1_1_qml_component.html#ac07b2cf80ebe0f0137042a7fbcd93d90">addQmlItem()</a> methods are included in the object list.</p>
<dl class="section note"><dt>Note</dt><dd>This class is available only if GCF is compiled and linked against Qt 5. </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae3297ce7f63c134d9d271d40fe396638"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3297ce7f63c134d9d271d40fe396638">&#9670;&nbsp;</a></span>QmlComponent()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GCF::QmlComponent::QmlComponent </td>
          <td>(</td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>parent</em> = <code>nullptr</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor. Creates an instance of this class and inserts it as a child under <code>parent</code>.</p>
<dl class="section note"><dt>Note</dt><dd>It is recommended that subclasses of <a class="el" href="class_g_c_f_1_1_gui_component.html">GCF::GuiComponent</a> declare their constructor as public and destructor as protected. This will ensure that the components are created on the heap always. </dd></dl>

</div>
</div>
<a id="a197ae580ded5c30ef7a91442ecc51bf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a197ae580ded5c30ef7a91442ecc51bf1">&#9670;&nbsp;</a></span>~QmlComponent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">GCF::QmlComponent::~QmlComponent </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Destructor.</p>
<dl class="section note"><dt>Note</dt><dd>It is recommended that subclasses of <a class="el" href="class_g_c_f_1_1_gui_component.html">GCF::GuiComponent</a> declare their constructor as public and destructor as protected. This will ensure that the components are created on the heap always. </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a949b57c9db4bbb8f7b5c44217a51d245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a949b57c9db4bbb8f7b5c44217a51d245">&#9670;&nbsp;</a></span>isActive()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool GCF::QmlComponent::isActive </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns true if the component has been activated. False otherwise.</p>
<p>This function is called when the <code>active</code> property is READ. The <code>active</code> property is notified as changed whenever this component receives a <a class="el" href="class_g_c_f_1_1_qml_component.html#a8d20f66abca3b375227adbf099444266">activationEvent()</a> or <a class="el" href="class_g_c_f_1_1_qml_component.html#ae94060a64aed580940b7e396d137e3bd">deactivationEvent()</a>. Change notifications to this property are signaled using the <a class="el" href="class_g_c_f_1_1_qml_component.html#a7db65fd422fc5dfaae093b507cd8f1b4">activeChanged()</a> signal. </p>

</div>
</div>
<a id="a7db65fd422fc5dfaae093b507cd8f1b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7db65fd422fc5dfaae093b507cd8f1b4">&#9670;&nbsp;</a></span>activeChanged()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::activeChanged </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>val</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This signal is emitted whenever the <code>active</code> property changes. </p>

</div>
</div>
<a id="a21f5a5a2e0e667083edd5f5e41ea1a3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21f5a5a2e0e667083edd5f5e41ea1a3e">&#9670;&nbsp;</a></span>addQml() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QObject * GCF::QmlComponent::addQml </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QUrl &amp;&#160;</td>
          <td class="paramname"><em>url</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function can be used to create a QML object from <code>url</code> and add it as a content-object of this component.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>name to be set on QML object loaded from <code>url</code>. </td></tr>
    <tr><td class="paramname">url</td><td>location of the <code></code>.qml file from which the QML object should be loaded. <code>http</code>, <code>file</code>, <code>ftp</code> and <code>qrc</code> schemes are supported. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the loaded QML object upon success, null upon failure.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>QML objects added using this function can access a <code>gComponent</code> object in their code to access methods on this component.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_g_c_f_1_1_component.html#ac8791368cb9615392e6c9c2d380034f1">GCF::Component::addContentObject()</a> </dd></dl>

</div>
</div>
<a id="adb31266005d6b24de63694fac0ad7ed9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb31266005d6b24de63694fac0ad7ed9">&#9670;&nbsp;</a></span>addQml() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QObject * GCF::QmlComponent::addQml </td>
          <td>(</td>
          <td class="paramtype">const QUrl &amp;&#160;</td>
          <td class="paramname"><em>url</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function adds a QML object from <code>url</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">url</td><td>location of the <code></code>.qml file from which the QML object should be loaded. <code>http</code>, <code>file</code>, <code>ftp</code> and <code>qrc</code> schemes are supported. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the loaded QML object upon success, null upon failure.</dd></dl>
<p>Name of the QML object is inferred from the file-name of the <code></code>.qml file specified in <code>url</code>.</p>
<dl class="section note"><dt>Note</dt><dd>QML objects added using this function can access a <code>gComponent</code> object in their code to access methods on this component. </dd></dl>

</div>
</div>
<a id="ac07b2cf80ebe0f0137042a7fbcd93d90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac07b2cf80ebe0f0137042a7fbcd93d90">&#9670;&nbsp;</a></span>addQmlItem()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::addQmlItem </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>object</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Adds a QML item as content object to this component</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>name of the QML object </td></tr>
    <tr><td class="paramname">object</td><td>pointer to the QML object</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function can be called from within QML code using <code>gComponent.addQmlItem(string,object)</code> </dd></dl>

</div>
</div>
<a id="a263ef1d66ac02c893161b9103fabd2a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a263ef1d66ac02c893161b9103fabd2a5">&#9670;&nbsp;</a></span>removeQmlItem() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::removeQmlItem </td>
          <td>(</td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>object</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Removes a QML item as content object from this component</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">object</td><td>pointer to the QML object that needs to be removed</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function can be called from within QML code using <code>gComponent.removeQmlItem(object)</code> </dd></dl>

</div>
</div>
<a id="a33008b1697ff642a3e0a930185a6c63f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33008b1697ff642a3e0a930185a6c63f">&#9670;&nbsp;</a></span>removeQmlItem() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::removeQmlItem </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Removes a QML item as content object from this component</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>name of the QML object that needs to be removed</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function can be called from within QML code using <code>gComponent.removeQmlItem(string)</code> </dd></dl>

</div>
</div>
<a id="a2e047dab3f159d529a265ab10fdce4ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e047dab3f159d529a265ab10fdce4ff">&#9670;&nbsp;</a></span>qmlItem()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QObject * GCF::QmlComponent::qmlItem </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns pointer to a QML object (or item) whose name is <code>name</code>. For this function to work a QML object should have been added using <a class="el" href="class_g_c_f_1_1_qml_component.html#ac07b2cf80ebe0f0137042a7fbcd93d90">addQmlItem()</a> for the same name before.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>name of the QML item/object to return </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the QML object. NULL if no such object was found.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function can be called from within QML code using <code>gComponent.qmlItem(string)</code> </dd></dl>

</div>
</div>
<a id="acc878e70ab78b826a58d488c85a7adf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc878e70ab78b826a58d488c85a7adf7">&#9670;&nbsp;</a></span>initializeEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::initializeEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_initialize_event.html">GCF::InitializeEvent</a> *&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This event handler is implemented to ASSERT crash the application, if the component is attempted for loading within a non QML application. It calls the base class implementation of the event handler otherwise. </p>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_component.html#a75422842587613d43844e73fb8ca021d">GCF::Component</a>.</p>

</div>
</div>
<a id="a8d20f66abca3b375227adbf099444266"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d20f66abca3b375227adbf099444266">&#9670;&nbsp;</a></span>activationEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::activationEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_activation_event.html">GCF::ActivationEvent</a> *&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Updates the <code>active</code> property and calls the base class implementation of this event handler </p>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_component.html#a464361482ef9039aee875940ae64306c">GCF::Component</a>.</p>

</div>
</div>
<a id="ae94060a64aed580940b7e396d137e3bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae94060a64aed580940b7e396d137e3bd">&#9670;&nbsp;</a></span>deactivationEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::deactivationEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_deactivation_event.html">GCF::DeactivationEvent</a> *&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Updates the <code>active</code> property and calls the base class implementation of this event handler </p>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_component.html#afb0e763839f42c3cca61d22c3ee7e1ce">GCF::Component</a>.</p>

</div>
</div>
<a id="a4369fecfd2a15454b5910aedb26f468e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4369fecfd2a15454b5910aedb26f468e">&#9670;&nbsp;</a></span>contentObjectLoadEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::contentObjectLoadEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_content_object_load_event.html">GCF::ContentObjectLoadEvent</a> *&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This event handler is implemented to look for a <code>type</code> key in the information map (<a class="el" href="class_g_c_f_1_1_content_object_load_event.html#adb2609b60cbd7beb86f426111a0fb262">GCF::ContentObjectLoadEvent::info()</a>) provided by the event-object. If the type is <code>qml</code>, then it looks for a <code>url</code> key in the information map and loads the <code></code>.qml file specified in <code>url</code> using the <a class="el" href="class_g_c_f_1_1_qml_component.html#aeed9744234d057c47cd85526551af630">loadQmlObject()</a> method.</p>
<p>If the <code>type</code> key is not <code>qml</code>, then the base class implementation of this event handler is called; which in turn calls the <a class="el" href="class_g_c_f_1_1_component.html#aa764b26829ba318385b3921bf2b1800a">loadObject()</a> method. </p>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_component.html#a8447de04766d75220159e9db2ceeb5c8">GCF::Component</a>.</p>

</div>
</div>
<a id="a9c927dfcac5f5388bb78efb94c1e420a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c927dfcac5f5388bb78efb94c1e420a">&#9670;&nbsp;</a></span>contentObjectMergeEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::contentObjectMergeEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_content_object_merge_event.html">GCF::ContentObjectMergeEvent</a> *&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This event hanlder is implemented to ignore merge events for QML objects </p>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_component.html#a1de83ead9a736b7fe19f61626b24a5b6">GCF::Component</a>.</p>

</div>
</div>
<a id="ae34b5127bb153d20ab27e9cc8c514325"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae34b5127bb153d20ab27e9cc8c514325">&#9670;&nbsp;</a></span>contentObjectUnloadEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::contentObjectUnloadEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_content_object_unload_event.html">GCF::ContentObjectUnloadEvent</a> *&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This event handler is implemented to look for a <code>type</code> key in the information map (<a class="el" href="class_g_c_f_1_1_content_object_load_event.html#adb2609b60cbd7beb86f426111a0fb262">GCF::ContentObjectLoadEvent::info()</a>) provided by the event-object. If the type is <code>qml</code>, then it calls the <a class="el" href="class_g_c_f_1_1_qml_component.html#a6df1b1a303bf1751c81db608c7647b14">unloadQmlObject()</a> method to unload the QML object.</p>
<p>If the <code>type</code> key is not <code>qml</code>, then the base class implementation of this event handler is called; which in turn calls the <a class="el" href="class_g_c_f_1_1_component.html#ad403e437d09e17139abe5bab8ae3f1e6">unloadObject()</a> method. </p>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_component.html#a692d57781b5f4e9034624e31b6727c14">GCF::Component</a>.</p>

</div>
</div>
<a id="ab746732385fc42c931e6802863d19d3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab746732385fc42c931e6802863d19d3c">&#9670;&nbsp;</a></span>contentObjectUnmergeEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::contentObjectUnmergeEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_content_object_unmerge_event.html">GCF::ContentObjectUnmergeEvent</a> *&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This event hanlder is implemented to ignore unmerge events for QML objects </p>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_component.html#a2ddd32175fb6ca0dec4ca0b7443543ce">GCF::Component</a>.</p>

</div>
</div>
<a id="a77275d9f06e56f415129e6f3c1a09784"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77275d9f06e56f415129e6f3c1a09784">&#9670;&nbsp;</a></span>activateContentObjectEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::activateContentObjectEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_activate_content_object_event.html">GCF::ActivateContentObjectEvent</a> *&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This event hanlder is implemented to ignore activation events for QML objects </p>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_component.html#acdc6848ac70f5c13c78b6782a5666cd3">GCF::Component</a>.</p>

</div>
</div>
<a id="a22a59c8b43d2583ae3756d0bf3169b12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22a59c8b43d2583ae3756d0bf3169b12">&#9670;&nbsp;</a></span>deactivateContentObjectEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void GCF::QmlComponent::deactivateContentObjectEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_g_c_f_1_1_deactivate_content_object_event.html">GCF::DeactivateContentObjectEvent</a> *&#160;</td>
          <td class="paramname"><em>e</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This event hanlder is implemented to ignore deactivation events for QML objects </p>

<p>Reimplemented from <a class="el" href="class_g_c_f_1_1_component.html#a8fe3cdb6bb891d7e67d498a3a55900b3">GCF::Component</a>.</p>

</div>
</div>
<a id="aeed9744234d057c47cd85526551af630"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeed9744234d057c47cd85526551af630">&#9670;&nbsp;</a></span>loadQmlObject()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">QObject * GCF::QmlComponent::loadQmlObject </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QUrl &amp;&#160;</td>
          <td class="paramname"><em>url</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QVariantMap &amp;&#160;</td>
          <td class="paramname"><em>info</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This function can be implemented to customize the loading a QML object from <code>url</code>. The default implementation loads the QML file at URL and returns a pointer to it. The default implementation also ensures that a <code>gComponent</code> object is available in the QML code that offers access to this component class.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>name of the QML object that needs to be loaded </td></tr>
    <tr><td class="paramname">url</td><td>URL from which the QML file needs to be loaded. If you reimplement this function you must ensure that <code>http</code>, <code>ftp</code>, <code>qrc</code> and <code>file</code> URL schemes are fully supported. </td></tr>
    <tr><td class="paramname">info</td><td>key=value information map associated with the QML object that needs to be loaded </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the QML object that was loaded. </dd></dl>

</div>
</div>
<a id="a6df1b1a303bf1751c81db608c7647b14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6df1b1a303bf1751c81db608c7647b14">&#9670;&nbsp;</a></span>unloadQmlObject()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool GCF::QmlComponent::unloadQmlObject </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>qmlObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QVariantMap &amp;&#160;</td>
          <td class="paramname"><em>info</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This function can be implemented to customize the unloading of a QML object. The default implementation simply deletes the QML object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>name of the QML object that needs to be unloaded </td></tr>
    <tr><td class="paramname">qmlObject</td><td>pointer to the QMl object that needs to be unloaded </td></tr>
    <tr><td class="paramname">info</td><td>key=value information map associated with the QML object that needs to be unloaded </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on successful unloading of the object, false otherwise. The default implemnetation always returns true. </dd></dl>

</div>
</div>
</div><!-- contents -->
<div class="ttc" id="agroup__gcf__core_html_ga051df405b83d549ef2b40870bd77df3c"><div class="ttname"><a href="group__gcf__core.html#ga051df405b83d549ef2b40870bd77df3c">GCF::url</a></div><div class="ttdeci">Q_DECL_IMPORT QString url()</div><div class="ttdef"><b>Definition:</b> GCFGlobal.cpp:67</div></div>
<div class="ttc" id="aclass_g_c_f_1_1_component_html_a424f54d7c57c719b0ec16c3094ca565a"><div class="ttname"><a href="class_g_c_f_1_1_component.html#a424f54d7c57c719b0ec16c3094ca565a">GCF::Component::name</a></div><div class="ttdeci">virtual QString name() const</div><div class="ttdef"><b>Definition:</b> Component.cpp:444</div></div>
</div>
</div>
</div>
<div class="footer_content">
<table width="100%" class="footer">
<tr>
<td align="left" width="50%">Copyright &copy; 2013-2019,
 <a class="el" href="http://www.vcreatelogic.com" target="_black">VCreate Logic Private Limited</a></td>
<td align="right" width="50%"><a class="el" href="http://www.vcreatelogic.com/products/gcf" target="_black">GCF - Generic Component Framework</a></td>
</tr>
</table>
</div>
</div>
</body>
</html>
